home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 4 / Amiga Tools 4.iso / tools / wb-enhancement / cgwbpat105 / cgwbpattern.man < prev    next >
Text File  |  1996-02-26  |  9KB  |  378 lines
  1. CGWBPattern                        Manual                            CGWBPattern
  2.  
  3.     NAME
  4.     
  5.       CGWBPPatch           - Main program
  6.  
  7.       Prefs/CGWBPattern  - Prefs
  8.     
  9.     
  10.     INTRODUCTION
  11.     
  12.         CyberGraphics has the wonderful feature that you can have a Workbench
  13.         with a serious quantity of colours.. Ever since i got my graphics card
  14.         and CyberGraphics i wanted to have a jpeg as a backdrop.. Would sure
  15.         look pretty, So i started to write CGWBPattern, and with the writing
  16.         it grew until it turned into what it is now.. A complete replacement
  17.         for WBPattern, with additional gimics ;-)
  18.  
  19.  
  20.     FEATURES
  21.         
  22.         Backdrop (pattern) updating (refreshing) is significantly faster then
  23.         WBPattern.
  24.  
  25.         Uses datatypes to load patterns
  26.  
  27.         6 different colour remap types (precisions).
  28.  
  29.         Change the Screenmode and the backdrop remaps to the new number of
  30.         colours to insure the backdrops always look as good as possible.
  31.  
  32.         CyberGraphics users can have 15/16/24bit backdrops using the
  33.         24bit picture.datatype.
  34.     
  35.         Optional random backdrops.
  36.  
  37.         Workbench windows can be changed to smart refresh for even faster
  38.         pattern updating
  39.  
  40.         FullWB toggle (with optional 'screen-to-front/back' gadget)
  41.  
  42.         Prefs program for easy setting.
  43.  
  44.         Memory used by patterns can be varied.          
  45.     
  46.  
  47.     INSTALLATION
  48.  
  49.         One off
  50.         
  51.         1. Copy bgui.library to libs: or do 'assign libs: libs add' from
  52.             the CGWBPattern dir.
  53.         
  54.         2.    Just execute 'CGWBPPatch' then play with the prefs prog.
  55.     
  56.         Perminant
  57.         
  58.         1. Open up WBPattern prefs, set to blank patterns.. Save (otherwise
  59.             you'll waste mem.).
  60.  
  61.         2. Copy Prefs/CGWBPattern to whereever you put your prefs progs.
  62.         
  63.         3. Copy bgui.library to libs:
  64.  
  65.         4. Copy CGWBPPatch to c: or whereever.
  66.  
  67.         5. Add 'CGWBPPatch' to your startup-sequence sometime <after>
  68.             'AddDatatypes' (it auto-detaches so no need to run it..).
  69.             
  70.         6. Play with the Prefs prog.      
  71.  
  72.     
  73.     USAGE
  74.     
  75.         CGWBPPatch
  76.  
  77.             Execute it once to patch the system, once more to remove the
  78.             patches (NB this can be dangerous.. If another program has
  79.             patched the same functions your system may guru).        
  80.         
  81.         Prefs/CGWBPattern
  82.         
  83.          - Gadgets (all have keyboard shortcuts)
  84.         
  85.              Workbench/Windows
  86.                  
  87.                  'Directory' ('Random' checked)
  88.                  
  89.                      Directory name from which the patterns are chosen, either
  90.                     enter by hand or click on the file requester gadget.
  91.  
  92.  
  93.                 'Pattern' ('Random' not checked)
  94.  
  95.                     Pattern to use, either enter by hand or click on the file
  96.                     requester gadget.
  97.                 
  98.  
  99.                 'Precision'
  100.                 
  101.                     Remap precision to use. the higher the precision the better
  102.                     the backdrops will look, however the higher the precision the
  103.                     longer the backdrops will take to load.. Experiment.
  104.                     
  105.                         Precision
  106.  
  107.                         worst -----> best
  108.                         
  109.                         GUI (1) -> Icon (2) -> Image (3) -> Exact (4)
  110.                         
  111.                         The Precisions are in this order in the cycle gad.
  112.                     
  113.                     Planes precision is no remapping at all.. Useful if, for
  114.                     example, you use MagicWB with only 8 colours and your
  115.                     patterns use these colours in the same order as the WB -
  116.                     Remapping, in this case, is not ness. so why not switch it
  117.                     off and gain some speed in loading?
  118.  
  119.                     Another use that springs to mind.. Seen those ArcPacks?
  120.                     with about 10ish different sets of colours... Rather
  121.                     than make a new copy of the pattern with different colours
  122.                     just change the WB Colours..
  123.                                         
  124.                     
  125.                     CyberGfx precision is only usable by those with CyberGraphics
  126.                     supported Graphics Cards.. Allows you to use 15/16/24 bit
  127.                     patterns (backdrops).
  128.                     
  129.  
  130.                 'Smart'
  131.                 
  132.                     Check this if you want the Workbench Window (or the Drawer
  133.                     windows) to be smart refresh instead of simple refresh -
  134.                     Smart refresh windows are faster to refresh but take up
  135.                     more memory.
  136.                     
  137.                     Don't check 'Smart' for the Workbench if you're in a
  138.                     CyberGraphics screemode with a depth greater than 8.
  139.                 
  140.  
  141.                 'Random'
  142.                 
  143.                     Check this if you want random patterns.
  144.                     
  145.                     A random pattern will be loaded each time the prefs changes
  146.                     (apart from 'WB Gadget' - toggling this has no effect on the
  147.                     patterns) or is read by CGWBPPatch (ie on startup or if you
  148.                     change the screenmode).
  149.                     
  150.  
  151.             'Full WB'
  152.  
  153.                 Check this and the Workbench titlebar will be hidden (the
  154.                 Workbench pattern will occupy the whole screen).
  155.             
  156.                 This only makes sence if the Workbench window is borderless.
  157.                 
  158.                 NB CGWBPattern uses electronic countermeasures ;-) to make
  159.                 sure the Workbench stays full or not. If you have several
  160.                 programs that toggle 'Full WB' running, the important one
  161.                 is this (trust me).
  162.                     
  163.  
  164.             'WB Gadget'
  165.  
  166.                 If you have a 'Full WB' but you want a 'Screen to front/back'
  167.                 gadget anyway check this.
  168.  
  169.     
  170.             'Mem Size'
  171.  
  172.                 Controls the way CGWBPattern allocates the memory for the
  173.                 patterns..
  174.  
  175.                     'Minimum'
  176.  
  177.                         Smallist allocation - least memory taken.. Slowest
  178.                         refresh.
  179.  
  180.                     'Standard'
  181.  
  182.                         Normal memory allocation. Normal refresh
  183.  
  184.                     'Maximum'
  185.  
  186.                         Largest memory allocation, fastest refresh.
  187.  
  188.             
  189.             'Save'
  190.  
  191.                 Saves the current settings to env: & envarc:
  192.  
  193.  
  194.             'Use'
  195.  
  196.                 Saves the current settings to env: (reboot and you'll
  197.                 get the old settings back)
  198.  
  199.  
  200.             'Test'                    
  201.                     
  202.                 Shows you what the current settings look like without commiting
  203.                 you to them (when you quit the prefs the prevous settings will
  204.                 be restored).
  205.     
  206.     
  207.             'Cancel'
  208.  
  209.                 Quit the preferences loosing any changes made.                    
  210.                     
  211.     
  212.          - Menus
  213.         
  214.             'Project'
  215.  
  216.                 'Open...'
  217.                 
  218.                     Load a previously saved prefs file.
  219.  
  220.                 'Save as...'
  221.                 
  222.                     Save the prefs as..
  223.  
  224.                 'About...'
  225.                 
  226.                     Pretty little window.
  227.  
  228.                 'Quit'
  229.                     
  230.                     Quit the preferences loosing any changes made.    
  231.                     
  232.  
  233.             'Edit'
  234.  
  235.                 'Last Saved'
  236.                 
  237.                     Re-loads the preferences from envarc:
  238.  
  239.                 'Restore'         
  240.                 
  241.                     Re-loads the preferences from env:
  242.  
  243.     
  244.     BUGS/PROBLEMS
  245.     
  246.         If you change a drawer to 'View by Icon' without closing/re-opening
  247.         the drawer, currently the pattern will not appear.
  248.         
  249.         CGWBPattern does not work with EGS (this <MAY> be changed).
  250.         I don't use it with EGS and no-one has yet written to me saying
  251.         that they do (well want to..).
  252.  
  253.  
  254.    SPECIAL REQUIREMENTS
  255.  
  256.        Needs OS 3.00 or higher.
  257.        CyberGraphics, Supported Gfx Card & the 24bit picture.datatype
  258.         to use the 15/16/24bit Precision.
  259.         bgui.library needed for preferences editor (included).
  260.  
  261.  
  262.     DISTRIBUTION
  263.     
  264.         CGWBPatternXXX (dir)
  265.  
  266.           Prefs (dir)
  267.             CGWBPattern
  268.                 CGWBPattern.info
  269.                 
  270.           CGWBPPatch
  271.              CGWBPattern.man
  272.            CGWBPatternXXX.readme
  273.  
  274.  
  275.  
  276.           libs (dir)
  277.             bgui.library         (c) Jan van den Baard
  278.  
  279.              Calvin.iff24                (c) Unknown
  280.              Planet.iff24                (c> Unknown
  281.  
  282.    AUTHOR
  283.  
  284.       Simon Richardson
  285.       simon@albert.demon.co.uk
  286.  
  287.  
  288.    COPYRIGHT
  289.  
  290.       Simon Richardson 1995.
  291.  
  292.  
  293.    PRICE
  294.  
  295.       CGWBPattern is emailware (if you like it let me know)
  296.  
  297.  
  298.    DISTRIBUTABILITY
  299.  
  300.       Freely Distributable, (c) 1994-95 Simon Richardon
  301.  
  302.  
  303.    DISCLAMER
  304.  
  305.         Standard boring disclamer that no-one reads anyway, about everything
  306.         being due to the law of chance and not my fault at all (and definitly
  307.         not my resposibility).. You know the old "use at your own peril" thingy..
  308.         Humm do you think they put that on razors? "If you accidently cut off part
  309.         of your body with this thing, or it explodes etc etc..". Makes you wonder
  310.         doesn't it?
  311.  
  312.       If you like it, use it.. If you hate it delete it.
  313.  
  314.  
  315.    HISTORY
  316.  
  317.     1.0     26/10/95 First version
  318.  
  319.  
  320.     1.01     26/10/95    (First Aminet release)
  321.       
  322.                          Can now set the window refresh type (NB don't make CGfx
  323.                         windows smart refresh)
  324.  
  325.                         Can optionally remove the Workbench title bar
  326.     
  327.     CGWBPPatch                    
  328.  
  329.         1.02    04/01/96        Added electronic contermeasures ;-)
  330.                                 BugFix: CGWBPPatch now unload patterns before quiting
  331.                                 (oops).
  332.                                 Only resets the WB if it needs to rather than every
  333.                                 time its prefs changes.
  334.                                 Added WB Gadget
  335.                                 The Workbench window always has its own pattern even
  336.                                 if its not borderless now.
  337.                                 'View by name' now works correctly
  338.                                 CGWBPPatch now detaches from the CLI again.
  339.                                 Now loads random files.
  340.                                 Changed the name slightly for clarity.
  341.                                 Misc small code changes and optimisations
  342.                                 
  343.         1.03    06/01/96        (Aminet Release)
  344.         
  345.                                 BugFix: Solved problem with stacksize caused by the
  346.                                 additional code for random patterns.
  347.                                 
  348.         1.04                    Added Planes precision
  349.  
  350.         1.041    14/01/96        BugFix: ShowTitle() would reset the WB sometimes
  351.                                 when unness.
  352.                                 
  353.         1.05    23/01/96        Now uses 24bit picture.datatype for CyberGfx
  354.                                 precision (also reduces code size & speeds
  355.                                 up loading & refreshing slightly..)                        
  356.                         
  357.                                 
  358.                                 
  359.     Prefs/CGWBPattern
  360.  
  361.         1.02    17/12/95        Added new gadgets, tided up GUI.
  362.  
  363.         1.03    03/01/96        Filename gadget now knows about dirs.
  364.  
  365.         1.04                  Added Planes precision.            
  366.  
  367.                                                         
  368.  
  369.    THANKS
  370.  
  371.         Jan van den Baard for  BGUI Library, i thought i'd try it for the
  372.         prefs editor.. Now i love it..
  373.  
  374.         Pierre Carrette & Walter Dörwald for your excellent 'layerhook'
  375.         example.
  376.  
  377.  
  378.